Sendbird UIKit/com.sendbird.uikit/SendbirdUIKit

SendbirdUIKit

open class SendbirdUIKit

Sendbird UIKit Main Class.

Types

LogLevel

enum LogLevel

UIKit log level.

ThemeMode

enum ThemeMode

UIKit theme mode.

Functions

authenticateFeed

open fun authenticateFeed(@Nullable handler: AuthenticationHandler)

Authenticate to Sendbird with given UserInfo.

connect

open fun connect(@Nullable handler: ConnectHandler)

Connects to Sendbird with given UserInfo.

disconnect

open fun disconnect(@Nullable handler: DisconnectHandler)

Disconnects from SendbirdChat.

getReplyType

@Deprecated

@NonNull

~~open~~ ~~fun~~ ~~getReplyType~~(): ReplyType

Returns ReplyType, which is how replies are displayed in the message list.

getThreadReplySelectType

@Deprecated

@NonNull

~~open~~ ~~fun~~ ~~getThreadReplySelectType~~(): ThreadReplySelectType

Returns ThreadReplySelectType, which determines where to go when reply is selected.

init

open fun init(@NonNull adapter: SendbirdUIKitAdapter, @NonNull context: Context)

Initializes Sendbird with given app ID.

initFromForeground

open fun initFromForeground(@NonNull adapter: SendbirdUIKitAdapter, @NonNull context: Context)

Initializes Sendbird from foreground with given app ID.

isDarkMode

open fun isDarkMode(): Boolean

Determines whether the theme mode is Dark.

isUsingChannelListMessageReceiptStatus

@Deprecated

~~open~~ ~~fun~~ ~~isUsingChannelListMessageReceiptStatus~~(): Boolean

Returns set value whether the states read-receipt and delivery-receipt are used on the channel list screen.

isUsingChannelListTypingIndicators

@Deprecated

~~open~~ ~~fun~~ ~~isUsingChannelListTypingIndicators~~(): Boolean

Returns set value whether the typing indicator is used on the channel list screen.

isUsingUserIdForNickname

open fun isUsingUserIdForNickname(): Boolean

Returns set value whether a nickname uses a user ID when there is no user nickname based on the user ID.

isUsingUserMention

@Deprecated

~~open~~ ~~fun~~ ~~isUsingUserMention~~(): Boolean

Returns set value whether the user mention is used on the channel screen.

isUsingVoiceMessage

@Deprecated

~~open~~ ~~fun~~ ~~isUsingVoiceMessage~~(): Boolean

Returns set value whether the voice message is used on the channel screen and message thread screen.

runOnUIThread

open fun runOnUIThread(@NonNull runnable: Runnable)

Context switching is performed to the main thread.

setLogLevel

open fun setLogLevel(@NonNull level: SendbirdUIKit.LogLevel)

setMentionConfig

open fun setMentionConfig(@NonNull config: UserMentionConfig)

Sets the user mention configuration.

setReplyType

@Deprecated

~~open~~ ~~fun~~ ~~setReplyType~~(@NonNull replyType: ReplyType)

Sets ReplyType, which is how replies are displayed in the message list.

setThreadReplySelectType

@Deprecated

~~open~~ ~~fun~~ ~~setThreadReplySelectType~~(@NonNull threadReplySelectType: ThreadReplySelectType)

Sets ThreadReplySelectType, which is how replies are displayed in the message list.

setUIKitFragmentFactory

@Deprecated

~~open~~ ~~fun~~ ~~setUIKitFragmentFactory~~(@NonNull factory: UIKitFragmentFactory)

Sets the factory that creates fragments generated by UIKit's basic activities.

setUseChannelListMessageReceiptStatus

@Deprecated

~~open~~ ~~fun~~ ~~setUseChannelListMessageReceiptStatus~~(useChannelListMessageReceiptStatus: Boolean)

Sets whether the states read-receipt and delivery-receipt are used on the channel list screen.

setUseChannelListTypingIndicators

@Deprecated

~~open~~ ~~fun~~ ~~setUseChannelListTypingIndicators~~(useChannelListTypingIndicators: Boolean)

Sets whether the typing indicator is used on the channel list screen.

setUseDefaultUserProfile

@Deprecated

~~open~~ ~~fun~~ ~~setUseDefaultUserProfile~~(useDefaultUserProfile: Boolean)

Sets whether the user profile uses.

setUseImageCompression

open fun setUseImageCompression(useCompression: Boolean)

Sets whether the image file compress when trying to send image file message.

setUseUserIdForNickname

open fun setUseUserIdForNickname(useUserIdForNickname: Boolean)

Sets whether a nickname uses a user ID when there is no user nickname based on the user ID.

setUseUserMention

@Deprecated

~~open~~ ~~fun~~ ~~setUseUserMention~~(useMention: Boolean)

Sets whether the user mention is used on the channel screen.

setUseVoiceMessage

@Deprecated

~~open~~ ~~fun~~ ~~setUseVoiceMessage~~(useVoiceMessage: Boolean)

Sets whether the voice message is used on the channel screen and message thread screen.

shouldUseDefaultUserProfile

@Deprecated

~~open~~ ~~fun~~ ~~shouldUseDefaultUserProfile~~(): Boolean

Returns set value whether the user profile uses.

shouldUseImageCompression

open fun shouldUseImageCompression(): Boolean

Returns the value whether the sending image file will be compressing.

startChatWithAiBot

open fun startChatWithAiBot( @NonNull context: Context, @NonNull botId: String, isDistinct: Boolean, @Nullable handler: CompletionHandler)

Initiates a group channel with the provided bot ID.

updateUserInfo

open fun updateUserInfo(@NonNull params: UserUpdateParams, @Nullable handler: CompletionHandler)

Updates current UserInfo.

Properties

adapter

@get:Nullable

open val adapter: SendbirdUIKitAdapter

compressQuality

open var compressQuality: Int

customParamsHandler

@Nullable

@get:Nullable

open var customParamsHandler: CustomParamsHandler

customUserListQueryHandler

@Nullable

@get:Nullable

open var customUserListQueryHandler: CustomUserListQueryHandler

defaultThemeMode

@NonNull

@get:NonNull

open var defaultThemeMode: SendbirdUIKit.ThemeMode

fragmentFactory

@NonNull

@get:Deprecated

@get:NonNull

open val fragmentFactory: UIKitFragmentFactory

resizingSize

@NonNull

@get:NonNull

open var resizingSize: Pair<Integer, Integer>

userMentionConfig

@NonNull

@get:NonNull

open val userMentionConfig: UserMentionConfig

voiceRecorderConfig

@NonNull

@get:NonNull

open var voiceRecorderConfig: VoiceRecorderConfig